Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update documentation for R package management with conda #393

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

WouterVanAssche
Copy link
Contributor

No description provided.

source/software/r_package_management.rst Outdated Show resolved Hide resolved
source/software/r_package_management.rst Outdated Show resolved Hide resolved

A lot of bioconda and bioconductor packages are not in sync with their dependencies, therefore you may need to create a separate environment for each of those packages to avoid conflicts.
A lot of bioconda and bioconductor packages are not in sync with their dependencies, therefore you may need to create a separate environment for each of those packages to avoid conflicts.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For bioconda I'm not sure, but with bioconductor this is because there are 2 releases per year, so dependencies can become somewhat older at some point. I would rather say here: start with installing the bioconductor (and bioconda?) packages and let conda figure out the dependencies.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not change the content of this remark, I just made it a propper .. note:: . I am not sure what the reason was behind this remark. Do you know @moravveji?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know where this comment comes from, but it is a very relevant one. So, I'd keep it.

@w-lampaert
Copy link
Contributor

It seems I completely missed this new review request, sorry. I don't know if this is still relevant, but looks good to me in any case

@@ -105,17 +88,19 @@ If the result is blank, or reports that conda can not be found, modify
the \`PATH\` environment variable appropriately by adding miniconda's bin
directory to PATH.

Creating a new conda environment is straightforward::
The next step is to create a new conda environment which can be done as follows::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some users are dummies. For such, we have to also mention that they need to pick a specific R version in advance, and substitute that below when <version>. Can you please include a sentence to cover this?

$ conda create -n science -c r r-essentials r-rodbc
This command creates a new conda environment called "science", and installs your prefered R
version from the conda-forge channel as well as the r-essentials bundle which includes number
of commonly used R packages such as ggplot2, glmnet, dplyr, tidyr, and shiny.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

following our style for the vsc pages, please change the typesetting for the package names by sandwiching them with opening/closing double-backticks; so that instead of ggplot2, we eventually render ggplot2.


A lot of bioconda and bioconductor packages are not in sync with their dependencies, therefore you may need to create a separate environment for each of those packages to avoid conflicts.
A lot of bioconda and bioconductor packages are not in sync with their dependencies, therefore you may need to create a separate environment for each of those packages to avoid conflicts.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know where this comment comes from, but it is a very relevant one. So, I'd keep it.

@@ -133,7 +118,7 @@ Here, science is the name of the environment you want to work in.
Install an additional package
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To install an additional package, e.g., \`pandas`, first ensure that the
To install an additional package, e.g., \`rodbc`, first ensure that the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instead of `rodbc, you need to put rodbc` in between opening/closing double-backticks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants